/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common.abstracts;

import org.balisunrise.application.Application;
import org.balisunrise.common.DAO;
import org.balisunrise.common.DAOProvider;
import org.balisunrise.common.VisualEntity;
import org.balisunrise.common.defaults.VEAUtil;

/**
 * Esta classe não é uma implementação real do VisualEntity.
 * Ela apenas encapsula os elementos comuns (não genéricos) para classes
 * que implementarem VisualEntity possam extender esta.
 *
 * @author Glauco
 * @see org.balisunrise.common.VisualEntity
 */
public abstract class AbstractVisualEntity extends AbstractVisualizable{

    /**
     * Classe da Entidade.
     */
    protected Class entityClass;

    /**
     * Alias (nome) da Representação Visual.
     */
    protected String alias;

    /**
     * Título da Representação Visual
     */
    protected String title;

    /**
     * get Alias (nome) da Representação Visual.
     * @return Alias (nome) da Representação Visual.
     */
    public String getAlias() {
        return alias;
    }

    /**
     * set Alias (nome) da Representação Visual.
     * @param alias Alias (nome) da Representação Visual.
     */
    public void setAlias(String alias) {
        this.alias = alias;
    }

    /**
     * get Classe da Entidade.
     * @return Classe da Entidade.
     */
    public Class getEntityClass() {
        return entityClass;
    }

    /**
     * set Classe da Entidade.
     * @param entityClass Classe da Entidade.
     */
    public void setEntityClass(Class entityClass) {
        this.entityClass = entityClass;
    }

    /**
     * get Títutlo.
     * @return Título da VisualEntity.
     */
    public String getTitle() {
        return title;
    }

    /**
     * set Título.
     * @param title Título da VisualEntity.
     */
    public void setTitle(String title) {
        this.title = title;
    }

    /**
     * Retorna o DAO do owner, caso o owner seja um DAOProvider, senão
     * verifica se esta instância é um VisualEntity, caso for retorna um DAO
     * do DAOManager, caso não for retorna null.
     *
     * @return DAO ou null.
     */
    public DAO getDAO(){

        if(owner instanceof DAOProvider)
            return ((DAOProvider) owner).getDAO();

        if (this instanceof VisualEntity)
            return Application.get().getDaoManager().getDAO((VisualEntity)this);

        DAOProvider dp = VEAUtil.getDAOProvider(owner);

        if (dp != null)
            return dp.getDAO();

        return Application.get().getDaoManager().getDAO();
    }
}
